GET api/v{version}/Vessels/GetWeatherData?vesselId={vesselId}&assetIds[0]={assetIds[0]}&assetIds[1]={assetIds[1]}&date={date}

Gets the deterministic weather data at the given assets on the given day for the metocean conditions to which the given vessel is sensitive.

Request Information

URI Parameters

Name	Description	Type	Additional information
vesselId	The ID of the vessel.	integer	Required
assetIds	The IDs of the assets.	Collection of integer	Required
date	The day for which weather data should be returned. Any time component will be ignored.	date	Required
version		string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of VesselWeatherDataItem

Name	Description	Type	Additional information
DatasetName	The name of the weather dataset.	string	None.
Asset	The asset to which the weather data value relates.	IAsset	None.
ForecastPoint	A location.	ForecastPoint	None.
Variable	A metocean condition.	MetoceanVariable	None.
TimeStamp	A point in time.	date	None.
VariableValue	The value of the metocean condition.	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DatasetName": "Dataset 1",
    "Asset": {
      "Id": 1,
      "Name": "Port",
      "Identifier": "Asset 1",
      "Latitude": 0.0,
      "Longitude": 1.0,
      "ForecastPoint": {
        "Id": 10,
        "Name": "Forecast point 10",
        "Latitude": 0.0,
        "Longitude": 1.0
      }
    },
    "ForecastPoint": {
      "Id": 10,
      "Name": "Forecast point 10",
      "Latitude": 0.0,
      "Longitude": 1.0
    },
    "Variable": {
      "Id": 1,
      "Name": "Significant wave height",
      "Units": "m",
      "IsDirection": false,
      "IsBelowThresholdSuccess": true
    },
    "TimeStamp": "2017-12-07T00:00:00",
    "VariableValue": 0.2
  },
  {
    "DatasetName": "Dataset 1",
    "Asset": {
      "Id": 1,
      "Name": "Port",
      "Identifier": "Asset 1",
      "Latitude": 0.0,
      "Longitude": 1.0,
      "ForecastPoint": {
        "Id": 10,
        "Name": "Forecast point 10",
        "Latitude": 0.0,
        "Longitude": 1.0
      }
    },
    "ForecastPoint": {
      "Id": 10,
      "Name": "Forecast point 10",
      "Latitude": 0.0,
      "Longitude": 1.0
    },
    "Variable": {
      "Id": 1,
      "Name": "Significant wave height",
      "Units": "m",
      "IsDirection": false,
      "IsBelowThresholdSuccess": true
    },
    "TimeStamp": "2017-12-07T01:00:00",
    "VariableValue": 0.3
  },
  {
    "DatasetName": "Dataset 1",
    "Asset": {
      "Id": 1,
      "Name": "Port",
      "Identifier": "Asset 1",
      "Latitude": 0.0,
      "Longitude": 1.0,
      "ForecastPoint": {
        "Id": 10,
        "Name": "Forecast point 10",
        "Latitude": 0.0,
        "Longitude": 1.0
      }
    },
    "ForecastPoint": {
      "Id": 10,
      "Name": "Forecast point 10",
      "Latitude": 0.0,
      "Longitude": 1.0
    },
    "Variable": {
      "Id": 2,
      "Name": "Wave period",
      "Units": "secs",
      "IsDirection": false,
      "IsBelowThresholdSuccess": true
    },
    "TimeStamp": "2017-12-07T00:00:00",
    "VariableValue": 3.6
  },
  {
    "DatasetName": "Dataset 1",
    "Asset": {
      "Id": 1,
      "Name": "Port",
      "Identifier": "Asset 1",
      "Latitude": 0.0,
      "Longitude": 1.0,
      "ForecastPoint": {
        "Id": 10,
        "Name": "Forecast point 10",
        "Latitude": 0.0,
        "Longitude": 1.0
      }
    },
    "ForecastPoint": {
      "Id": 10,
      "Name": "Forecast point 10",
      "Latitude": 0.0,
      "Longitude": 1.0
    },
    "Variable": {
      "Id": 2,
      "Name": "Wave period",
      "Units": "secs",
      "IsDirection": false,
      "IsBelowThresholdSuccess": true
    },
    "TimeStamp": "2017-12-07T01:00:00",
    "VariableValue": 3.5
  },
  {
    "DatasetName": "Dataset 1",
    "Asset": {
      "Id": 2,
      "Name": "A1",
      "Identifier": "Asset 2",
      "Latitude": 1.0,
      "Longitude": 0.0,
      "ForecastPoint": {
        "Id": 3,
        "Name": "Forecast point 3",
        "Latitude": 1.1,
        "Longitude": 0.0
      }
    },
    "ForecastPoint": {
      "Id": 3,
      "Name": "Forecast point 3",
      "Latitude": 1.1,
      "Longitude": 0.0
    },
    "Variable": {
      "Id": 2,
      "Name": "Wave period",
      "Units": "secs",
      "IsDirection": false,
      "IsBelowThresholdSuccess": true
    },
    "TimeStamp": "2017-12-07T00:00:00",
    "VariableValue": 4.0
  },
  {
    "DatasetName": "Dataset 1",
    "Asset": {
      "Id": 2,
      "Name": "A1",
      "Identifier": "Asset 2",
      "Latitude": 1.0,
      "Longitude": 0.0,
      "ForecastPoint": {
        "Id": 3,
        "Name": "Forecast point 3",
        "Latitude": 1.1,
        "Longitude": 0.0
      }
    },
    "ForecastPoint": {
      "Id": 3,
      "Name": "Forecast point 3",
      "Latitude": 1.1,
      "Longitude": 0.0
    },
    "Variable": {
      "Id": 2,
      "Name": "Wave period",
      "Units": "secs",
      "IsDirection": false,
      "IsBelowThresholdSuccess": true
    },
    "TimeStamp": "2017-12-07T01:00:00",
    "VariableValue": 4.1
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.